home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 11 / Cream of the Crop 11-2.iso / bbs / mcm10g5.zip / SRIF11.DOC < prev    next >
Text File  |  1996-01-17  |  7KB  |  169 lines
  1.  
  2.                           ===================
  3.                           S R I F Version 1.1
  4.                           ===================
  5.  
  6.                 Information / Description of a new standard
  7.  
  8.                                 S  tandard
  9.                                 R  equest
  10.                                 I  nformation
  11.                                 F  ile
  12.  
  13.          Copyright (c) 1994-1995 by Gordian Schuermann & Mirko Mucko
  14.  
  15.  
  16. I  Overview
  17.                 Introduction                            0
  18.                 Description in general                  1
  19.                   Required statements                   1.1
  20.                   Optional statements                   1.2
  21.                   Undefined options                     1.3
  22.                 Implementation                          2.0
  23.  
  24.  
  25.  
  26.  
  27. 0. Introduction
  28.  In common, more and more mailer are about to implement the ability to
  29.  call external request processors. But very soon, we discovered a command
  30.  line cannot handle all the information the mailer has and the ERP needs.
  31.  
  32.  To transfer the information in a proper and fast way, we designed and
  33.  implemented the S R I F option in the mean it will be a standard soon.
  34.  
  35.  The structure and idea is protected by copyright law, except these
  36.  circumstances:
  37.  
  38.         +  you may distrubute, use and implement this structure for free
  39.         +  you have not to pay any value for usage of these methodes
  40.         +  you should note in your documentation the origin of SRIF
  41.  
  42. 1. Descritption
  43.  The SRIF name is the only parameter given from the Mailer to the External
  44.  Request Processor. The file is designated as a so called "plain vanilla ASCII"
  45.  file, filled with pre-defined, optional and not-yet defined statemets.
  46.  
  47.  We discussed the possibility of binary files, and of EMSI-like files, but
  48.  a plain ASCII control file is more flexible and can be read faster by
  49.  various program languages (C, Pascal, Basic, Cobol ect).
  50.  
  51.  In the SRIF, one command plus parameter is allowed per line, the file
  52.  is unlimited in length, comments are not allowed.
  53.  
  54.  The SRIF is generated by the Mailer and after the ERP finished its work,
  55.  the Mailer is responsible for erasing the SRIF.
  56.  
  57. 1.1 Required statements
  58.  The following statements are required for the ERP:
  59.  
  60.  
  61.        Sysop            <Sysop_Name>
  62.                         This is the name of the remote sysop
  63.  
  64.        AKA              <Zone:Net/Node[.Point][@Domain]>
  65.                         This is the main aka of the remote system in 4D or
  66.                         5D notation. A zero as point number may be ommited,
  67.                         the domain with "@" is optional
  68.  
  69.        Baud             <Current LINE rate>
  70.                         This is the effective baud rate, not the fixed DTE rate
  71.  
  72.        Time             <Time in minutes>
  73.                         This is the time till next event which does not allow
  74.                         file requests. Use -1 if no limits
  75.  
  76.        RequestList      <File of request list>
  77.                         This is the filename of the list containing requested
  78.                         files.
  79.        ResponseList     <File of response list>
  80.                         This is the filename of the response list.
  81.                         It must not be equal to RequestList. One file per line,
  82.                         including drives/pathes to the file. The first
  83.                         character defines the way the mailer should act after
  84.                         sending that file:
  85.  
  86.                          =   erase file if sent successfully
  87.                          +   do not erase the file after sent
  88.                          -   erase the file in any case after session
  89.  
  90.        RemoteStatus     <PROTECTED or UNPROTECTED>
  91.                         Defines whether the session is protected by password
  92.                         or not
  93.  
  94.        SystemStatus     <LISTED or UNLISTED>
  95.                         Defines whether the remote system is listed in any
  96.                         current nodelist of system.
  97.  
  98. 1.2 Optional statements
  99.  These parameters are already known and defined, but a ERP should run also
  100.  without them:
  101.  
  102.        SessionProtocoll <e.g. ZAP,ZMO,XMA
  103.  
  104.        AKA              <Zone:Net/Node[.Point][@Domain]>
  105.                         Additional AKAs. One AKA is required (see REQUIRED
  106.                         section)
  107.  
  108.        Site             <Site Info>
  109.                          The site info as given e.g. in EMSI handshake
  110.  
  111.        Location         <Location and/or ZIP>
  112.                          The location info as given e.g. in EMSI handshake
  113.  
  114.        Phone            <Phone Number>
  115.                          The  phone number info as given e.g. in EMSI handshake
  116.  
  117.        Password         <Session password>
  118.                          On protected sessions, the session password. If
  119.                          no protected session, this parameter must be ommited!
  120.  
  121.        DTE              <Current DTE rate>
  122.                          The PC<->Modem speed (so call DTE rate)
  123.  
  124.        PORT             <Communcationport>
  125.                          Used comport by the application
  126.  
  127.        Mailer           <Remote's mailer if EMSI>
  128.                           The Mailer name as defined by FTC
  129.  
  130.        MailerCode       <Remote's FTSC code>
  131.                           The hex code of the remote mailer as defined by FTC
  132.  
  133.        SerialNumber     <Remote's serial number if passed>
  134.                          The remote mailer's serial number if transfered
  135.  
  136.        Version          <Remote's version number if EMSI>
  137.                          The remote mailer's version number if transfered
  138.  
  139.        Revision         <remote's revision number if EMSI>
  140.                          The remote mailer's revision number if transfered
  141.  
  142.        SessionType      <may be EMSI, FTSC0001, WAZOO, JANUS, HYDRA or OTHER>
  143.                          The session-type, this may be one of the known
  144.                          session types or "OTHER" if not (yet) defined
  145.  
  146.        OurAKA           <AKA which has been called for proper response>
  147.                          If the mailer does AKA matching, the AKA of the
  148.                          mailer being called
  149.  
  150.        TRANX            <Tranx Line as 8 digit hex string>
  151.                          The unix-style time stamp (hexadecimal notation
  152.                          of seconds since 1.1.1980)
  153.  
  154. 1.3 Undefined options
  155.  There may be the need to add new commands / parameters to the SRI file. If
  156.  so, they may be added, but inform us to keep the documentation "up to date"
  157.  and to share your good ideas with other autors of software for FIDONet.
  158.  
  159.  
  160. 2.0 Implementation
  161.  SRIF is implemented in these fine products already :
  162.  
  163.                 Mailer                  Request Processor
  164.                 ------------------------------------------------------
  165.                 McMail                  xOR
  166.                                         EasyErp
  167.  
  168.  Other products will follow soon !
  169.